<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>libdill</title>
  <link rel="stylesheet" type="text/css" href="main.css">
</head>
<body>

<h1>libdill: Structured Concurrency for C</h1>

<ul id='toplist'>
<li><a href="index.html">Home</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a href="tutorial.html">Tutorials</a></li>
<li><a href="faq.html">FAQ</a></li>
</ul>
<h1 id="name">NAME</h1>
<p>yield - yields CPU to other coroutines</p>
<h1 id="synopsis">SYNOPSIS</h1>
<div class="sourceCode"><pre class="sourceCode c"><code class="sourceCode c"><span class="pp">#include </span><span class="im">&lt;libdill.h&gt;</span>

<span class="dt">int</span> yield(<span class="dt">void</span>);</code></pre></div>
<h1 id="description">DESCRIPTION</h1>
<p>By calling this function, you give other coroutines a chance to run.</p>
<p>You should consider using <strong>yield</strong> when doing lengthy computations which don't have natural coroutine switching points such as socket or channel operations or msleep.</p>
<h1 id="return-value">RETURN VALUE</h1>
<p>In case of success the function returns 0. In case of error it returns -1 and sets <strong>errno</strong> to one of the values below.</p>
<h1 id="errors">ERRORS</h1>
<ul>
<li><strong>ECANCELED</strong>: Current coroutine was canceled.</li>
</ul>
<h1 id="example">EXAMPLE</h1>
<div class="sourceCode"><pre class="sourceCode c"><code class="sourceCode c"><span class="cf">for</span>(i = <span class="dv">0</span>; i != <span class="dv">1000000</span>; ++i) {
    expensive_computation();
    yield(); <span class="co">/* Give other coroutines a chance to run. */</span>
}</code></pre></div>
<h1 id="see-also">SEE ALSO</h1>
<p><strong>bundle</strong>(3) <strong>bundle_go</strong>(3) <strong>bundle_go_mem</strong>(3) <strong>bundle_mem</strong>(3) <strong>bundle_wait</strong>(3) <strong>go</strong>(3) <strong>go_mem</strong>(3)</p>
</body>
